AnimationDomain

class AnimationDomain : Domain

AnimationDomain represents Animation protocol domain request/response operations and events that can be captured.

This API is marked as experimental in protocol definition and can change in the future.

Functions

animationCanceled

fun animationCanceled(): Flowable<AnimationCanceledEvent>

Event for when an animation has been cancelled.

animationCreated

fun animationCreated(): Flowable<AnimationCreatedEvent>

Event for each animation that has been created.

animationStarted

fun animationStarted(): Flowable<AnimationStartedEvent>

Event for animation that has been started.

description

fun description(): String

Returns domain description.

disable

fun disable(): Single<RequestResponseFrame>

Disables animation domain notifications.

enable

fun enable(): Single<RequestResponseFrame>

Enables animation domain notifications.

events

fun events(): Flowable<Event>

Returns flowable capturing all domains events.

fun events(filter: Predicate<Event>): Flowable<Event>

Returns flowable capturing all domains events matching predicate.

fun <T : Event> events(eventClass: Class<T>): Flowable<T>

Returns flowable capturing all domain events of a given type.

fun <T : Event> events(eventClass: Class<T>, filter: Predicate<T>): Flowable<T>

Returns flowable capturing all domain events of a given type matching predicate.

getCurrentTime

fun getCurrentTime(input: GetCurrentTimeRequest): Single<GetCurrentTimeResponse>

Returns the current time of the an animation.

getDependencies

open override fun getDependencies(): List<Domain>

Returns list of dependant domains that should be enabled prior to enabling this domain.

getPlaybackRate

fun getPlaybackRate(): Single<GetPlaybackRateResponse>

Gets the playback rate of the document timeline.

name

fun name(): String

Returns domain name.

releaseAnimations

fun releaseAnimations(input: ReleaseAnimationsRequest): Single<RequestResponseFrame>

Releases a set of animations to no longer be manipulated.

resolveAnimation

fun resolveAnimation(input: ResolveAnimationRequest): Single<ResolveAnimationResponse>

Gets the remote object of the Animation.

seekAnimations

fun seekAnimations(input: SeekAnimationsRequest): Single<RequestResponseFrame>

Seek a set of animations to a particular time within each animation.

setPaused

fun setPaused(input: SetPausedRequest): Single<RequestResponseFrame>

Sets the paused state of a set of animations.

setPlaybackRate

fun setPlaybackRate(input: SetPlaybackRateRequest): Single<RequestResponseFrame>

Sets the playback rate of the document timeline.

setTiming

fun setTiming(input: SetTimingRequest): Single<RequestResponseFrame>

Sets the timing of an animation node.

Sources

jvm source